Updating DLC-Live! GUI to pyside6 and multicamera support #35

arturoptophys · 2026-01-13T12:05:03Z

This PR supercedes the #34

Compared to the previos PR this:

changed the pqt bindings to pyside6
added simultaneuos multicamera support (with multiple backends)
added h265 hardware encoding as well as mac-specific hardware encoding options

…modern-python-and-pyqt6 Add Basler and GenTL camera backends for modular capture

…era-functionality

…camera-functionality Rework layout and camera handling controls

…' into artur/test_update

…r integration - Implemented `get_device_count` method in `GenTLCameraBackend` to retrieve the number of GenTL devices detected. - Added `max_devices` configuration option in `CameraSettings` to limit device probing. - Introduced `BoundingBoxSettings` for bounding box visualization, integrated into the main GUI. - Enhanced `DLCLiveProcessor` to accept a processor instance during configuration. - Updated GUI to support processor selection and auto-recording based on processor commands. - Refactored camera properties handling and removed deprecated advanced properties editor. - Improved error handling and logging for processor connections and recording states.

…e display

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

… options to config

- Update configuration settings to include support for single-animal models in DLCProcessorSettings. - Improve user guide with a link to DLC documentation for model export.

…le_animal in DLCLiveProcessor settings

- Implemented MultiCameraController to manage multiple cameras simultaneously.

…fix for basler backend

…timization

…me data without tiling and track source camera ID

…ulti-camera controller

… updates

deruyter92

@arturoptophys, great PR! I think this is going to be super helpful.

I think we should aim to merge as soon as DeepLabCut-live 1.2 release is official. This PR is getting quite big already.

Let me know if you want me to look at specific components that you are unsure of / need help with.

Ofc it would be great to add some testing as well..

deruyter92 · 2026-01-22T13:39:40Z

setup.py

+"""Setup configuration for the DeepLabCut Live GUI."""

+from __future__ import annotations

 import setuptools

-with open("README.md", "r") as fh:
+with open("README.md", "r", encoding="utf-8") as fh:
    long_description = fh.read()

 setuptools.setup(
    name="deeplabcut-live-gui",
-    version="1.0",
+    version="2.0",
    author="A. & M. Mathis Labs",
    author_email="adim@deeplabcut.org",
-    description="GUI to run real time deeplabcut experiments",
+    description="PySide6-based GUI to run real time DeepLabCut experiments",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/DeepLabCut/DeepLabCut-live-GUI",
-    python_requires=">=3.5, <3.11",
+    python_requires=">=3.10",
    install_requires=[
        "deeplabcut-live",
-        "pyserial",
-        "pandas",
-        "tables",
-        "multiprocess",
-        "imutils",
-        "pillow",
-        "tqdm",
+        "PySide6",
+        "numpy",
+        "opencv-python",
+        "vidgear[core]",
    ],
+    extras_require={
+        "basler": ["pypylon"],
+        "gentl": ["harvesters"],
+    },
    packages=setuptools.find_packages(),
    include_package_data=True,
    classifiers=(
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
        "Operating System :: OS Independent",
    ),
    entry_points={
        "console_scripts": [
-            "dlclivegui=dlclivegui.dlclivegui:main",
-            "dlclivegui-video=dlclivegui.video:main",
+            "dlclivegui=dlclivegui.gui:main",
        ]
    },
 )


I think setup.py should be removed. All information is in pyproject.toml now, and having this duplicated list of dependencies here is only confusing (or potentially conflicting). Setuptools works perfectly fine without setup.py now, since you made the pyproject.toml PEP 517 / 518 / 621–compliant.

You could keep only the following code if you want:

Suggested change

from setuptools import setup

# Only kept for compatibility with external legacy tools.

# All information is now in pyproject.toml.

setup()

deruyter92 · 2026-01-22T13:54:12Z

README.md

+# Install with gentl support
+pip install deeplabcut-live-gui[gentl]


Maybe also add basler here:

Suggested change

# Install with gentl support

pip install deeplabcut-live-gui[gentl]

# Install with gentl support

pip install deeplabcut-live-gui[gentl]

# Install with basler support

pip install deeplabcut-live-gui[basler]

deruyter92 · 2026-01-22T13:55:42Z

README.md

+# Install with gentl support
+pip install deeplabcut-live-gui[gentl]
+```
+


Maybe add an additional block on how to install from source:

Editable Installation from Source (for contributors or advanced users)

Clone the repository

git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git cd DeepLabCut-live-GUI

Install editable package using pip or the uv package manager

# Using pip pip install -e . # Or using uv uv sync

deruyter92 · 2026-01-22T13:57:06Z

README.md

+2. **Select Camera Backend**: Choose from the dropdown (opencv, gentl, aravis, basler)

-#### Processor (optional)
+3. **Configure Camera**: Set FPS, exposure, gain, and other parameters


This section is not updated for the multi-camera setup yet, is it?

deruyter92 · 2026-01-22T13:58:58Z

README.md

+The GUI supports PyTorch DLCLive models:

-If you would not like to save the data from the session, please click `Delete Video`, and all data will be discarded. After you click `Save Video` or `Delete Video`, the `Off` button will be selected, indicating you can now set up a new session.
+1. **PyTorch**: PyTorch-based models (requires PyTorch installation)


Ideally the Pytorch dependency is automatically handled by DeepLabCut-live to avoid issues.

deruyter92 · 2026-01-22T14:02:36Z

pyproject.toml

+]
+
+dependencies = [
+    "deeplabcut-live", # might be missing timm and scipy


Let's specify this minimal version (old version is incompatible). And let's have the PyTorch dependency handled by deeplabcut-live (installs scipy, timm and torch automatically).

Suggested change

"deeplabcut-live", # might be missing timm and scipy

"deeplabcut-live[pytorch] >= 1.1.0"

NOTE: the required deeplabcut-live version is not officially released yet

on my windows machine the current dlclive3 branch installed with [pytorch] flag does not install cuda-compiled version of pytorch i had to manually install pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu130

deruyter92 · 2026-01-22T14:27:21Z

dlclivegui/dlc_processor.py

+                LOGGER.exception("Pose inference failed", exc_info=exc)
+                self.error.emit(str(exc))
+            finally:
+                self._queue.task_done()


I encountered this race condition: when stopping, _stop_worker() sets self._queue = None (line 236) while the worker thread is in the finally block. (I think..?)

Suggested change

self._queue.task_done()

if self._queue is not None:

self._queue.task_done()

deruyter92 · 2026-01-22T14:42:35Z

dlclivegui/processors/dlc_processor_socket.py

+                save_dict = self.get_data()
+                path2save = Path(__file__).parent.parent.parent / "data" / file
+                LOG.info(f"Path should be {path2save}")
+                pickle.dump(save_dict, open(path2save, "wb"))


Needs context manager?

Suggested change

pickle.dump(save_dict, open(path2save, "wb"))

with path2save.open("wb") as f:

pickle.dump(save_dict, f)

deruyter92 · 2026-01-22T14:48:14Z

dlclivegui/gui.py

+        text = value.strip()
+        if not text:
+            return {}
+        return json.loads(text)


add error handling:

Suggested change

return json.loads(text)

try:

return json.loads(text)

except json.JSONDecodeError as e:

logging.warning(f"Invalid JSON in additional options: {e}. Using empty dict.")

return {}

deruyter92 · 2026-01-22T14:54:21Z

dlclivegui/gui.py

+        is_dlc_camera_frame = frame_data.source_camera_id == dlc_cam_id
+
+        # Update tile info and raw frame only when DLC camera frame arrives
+        if is_dlc_camera_frame and dlc_cam_id in frame_data.frames:


could fail if dlc_cam_id is None

Suggested change

if is_dlc_camera_frame and dlc_cam_id in frame_data.frames:

if is_dlc_camera_frame and dlc_cam_id is not None and dlc_cam_id in frame_data.frames:

C-Achard · 2026-01-23T13:14:45Z

@deruyter92 @arturoptophys See #36 for ongoing end-to-end GUI testing efforts

arturoptophys and others added 30 commits October 21, 2025 11:22

Add modular camera backends with Basler and GenTL support

cc55285

Merge pull request #1 from arturoptophys/codex/update-repository-for-…

09abd98

…modern-python-and-pyqt6 Add Basler and GenTL camera backends for modular capture

Rearrange UI and improve camera controls

893b28a

modifyed gentl_backend

0b0ac33

Merge branch 'artur/test_update' into codex/update-gui-to-enhance-cam…

b13a417

…era-functionality

Improve camera control flow and recording alignment

8110085

Merge pull request #2 from arturoptophys/codex/update-gui-to-enhance-…

8e728e7

…camera-functionality Rework layout and camera handling controls

Improve camera stop flow and parameter propagation

efda9d3

Merge branch 'codex/update-gui-to-enhance-camera-functionality-xq83kx…

13bff62

…' into artur/test_update

fixed video recordings (roughly)

f39c4c4

updates

7e7e3b6

Added processors

6402566

update processors

c81e897

fixing sizes

c7ee2f1

modified the processor to be controllable

7823829

formatting and precommit workflow

f1ab8b0

documentations

39be1b2

update dlc_processor, fix filtering

ddcbc41

setting frame resolution

e2ff610

updated to look for model files

44de723

dropped tensorflow support via GUI

a5e70a6

more profiling of the processes

229a839

Add visualization settings and update camera backend for improved pos…

448bdc5

…e display

small bug fixes

246452f

black formatting

103399c

some docs

bcd89cc

updated docs

7b70c24

Update dlclivegui/gui.py

94ccc7b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Rename DLC Processor to DeepLabCut Processor

c5659d7

arturoptophys added 13 commits December 9, 2025 10:36

Moved path2models as well as optional device and further DLCProcessor…

89cc84a

… options to config

remove path from docstring

edf6b80

fix exposure settings in gentl backend

37ca392

Add logging for camera configuration and error handling in backends

05ff126

- Update configuration settings to include support for single-animal models in DLCProcessorSettings. - Improve user guide with a link to DLC documentation for model export.

Set default device to 'auto' in DLCProcessorSettings and include sing…

5634059

…le_animal in DLCLiveProcessor settings

Add multi-camera controller for DLC Live GUI

1b8622c

- Implemented MultiCameraController to manage multiple cameras simultaneously.

Refactor multi-camera handling to use camera IDs instead of indices; …

5c7ee50

…fix for basler backend

Enhance multi-camera support with tiled view rendering and display op…

f332291

…timization

Refactor multi-camera frame handling to improve performance; emit fra…

009d0d5

…me data without tiling and track source camera ID

switched to pyside as gui backend

557403f

Add camera availability check and handle initialization failures in m…

be91086

…ulti-camera controller

Add camera preview functionality with start/stop toggle and real-time…

6957468

… updates

support multi-animal poses with distinct markers

51fed8a

MMathisLab requested review from C-Achard and deruyter92 January 13, 2026 12:06

MMathisLab mentioned this pull request Jan 13, 2026

Updating DLCLive!-GUI to pyQt6 as well as DLC3/pytorch models #34

Closed

MMathisLab added the enhancement New feature or request label Jan 13, 2026

deruyter92 reviewed Jan 22, 2026

View reviewed changes

C-Achard mentioned this pull request Jan 23, 2026

Setup GUI testing #36

Draft

6 tasks

C-Achard added this to the Multi-camera setup milestone Jan 23, 2026

+from setuptools import setup
+# Only kept for compatibility with external legacy tools.
+# All information is now in pyproject.toml.
+setup()

		# Install with gentl support
		pip install deeplabcut-live-gui[gentl]

	"deeplabcut-live", # might be missing timm and scipy
	"deeplabcut-live[pytorch] >= 1.1.0"

	self._queue.task_done()
	if self._queue is not None:
	self._queue.task_done()

	pickle.dump(save_dict, open(path2save, "wb"))
	with path2save.open("wb") as f:
	pickle.dump(save_dict, f)

	if is_dlc_camera_frame and dlc_cam_id in frame_data.frames:
	if is_dlc_camera_frame and dlc_cam_id is not None and dlc_cam_id in frame_data.frames:

Updating DLC-Live! GUI to pyside6 and multicamera support #35

Are you sure you want to change the base?

Updating DLC-Live! GUI to pyside6 and multicamera support #35

Uh oh!

Conversation

arturoptophys commented Jan 13, 2026

Uh oh!

deruyter92 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Editable Installation from Source (for contributors or advanced users)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

C-Achard commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants